{"action":"created","comment":{"url":"https://api.github.com/repos/ntt-ns/spp/pulls/comments/244309037","pull_request_review_id":188277555,"id":244309037,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI0NDMwOTAzNw==","diff_hunk":"@@ -0,0 +1,94 @@\n+..  SPDX-License-Identifier: BSD-3-Clause\n+    Copyright(c) 2010-2014 Intel Corporation\n+\n+.. _spp_pcap_design:\n+\n+Design\n+======\n+\n+.. _spp_pcap_design_outline:\n+\n+\n+Design Overview\n+---------------\n+\n+This section outlines design of ``spp_pcap``.\n+\n+When launched, ``spp_pcap`` assigns master core as ``receiver`` thread and\n+the rest of the cores are assigned ``writer`` thread(s). Writing packets into\n+storage takes much cpu power to write packets. If writing is done by only\n+one core, then there is a risk of packet be dropped. That is the reason\n+why there can be multiple ``writer`` threads. Each ``writer`` thread has\n+unique integer number which is used to create capture file name.\n+When launched, ``spp_pcap`` connect to the ``port`` which is specified\n+in startup parameter. Note that ``vhost`` can not be specified as ``port``.\n+When spp_pcap has launched, initially it is not capturing.\n+\n+With ``start`` command, you can start capturing.\n+Incoming packets are received by ``receiver`` thread and it is transferred to\n+``writer`` thread(s) via multi-producer/multi-consumer ring.\n+Multi-producer/multi-consumer ring is the ring which multiple producers\n+can enqueue and multiple consumers can dequeue. When those packets are\n+received by ``writer`` thread(s), it will be compressed using LZ4 library and\n+then be written to storage. In case more than 1 cores are assigned,\n+incoming packets are written into storage per core basis so packet capture file\n+will be divided per core.\n+When ``spp_pcap`` has already been started, ``start`` command cannot\n+be accepted.\n+\n+With ``stop`` command, capture will be stopped. When spp_pcap has already\n+been stopped, ``stop`` command cannot be accepted.\n+\n+With ``exit`` command, ``spp_pcap`` exits the program. ``exit`` command\n+during started state, stops capturing and then exits the program.\n+\n+With ``status`` command, status related to ``spp_pcap`` is shown.\n+\n+The following depicts the internal structure of ``spp_pcap``.\n+\n+.. figure:: ../images/spp_pcap/spp_pcap_design.*\n+    :width: 75%\n+\n+    spp_pcap internal structure\n+\n+.. _spp_pcap_design_output_file_format:\n+\n+Startup options\n+---------------\n+\n+Like primary process, ``spp_pcap`` has two kinds of options. One is for DPDK,\n+the other is ``spp_pcap``.\n+\n+``spp_pcap`` specific options are:\n+\n+ * -client-id: client id which can be seen as secondary ID from spp.py\n+ * -s: IPv4 address and port for spp-ctl\n+ * -i: port to which spp_pcap attached with\n+ * --output: Output file path where capture files are written.\\\n+   When this parameter is omitted,``/tmp`` is used.\n+\n+The output file format is as following:\n+\n+    spp_pcap.YYYMMDDhhmmss.[port_name].[write_core_number(1,2...)]\n+    .[sequence_number(0,1..)].pcap.lz4\n+\n+YYYYMMDDhhmmss is the time when ``spp_pcap`` receives ``start`` command.\n+\n+The example file name is as follwoing:","path":"docs/guides/spp_pcap/design.rst","position":77,"original_position":77,"commit_id":"07276ce3c05b2402e3281c2febd94ab95a5f8124","original_commit_id":"e3c775268fbb322cec5147830fe93ce444cc0fb4","user":{"login":"Hideyuki-Yamashita","id":38413306,"node_id":"MDQ6VXNlcjM4NDEzMzA2","avatar_url":"https://avatars2.githubusercontent.com/u/38413306?v=4","gravatar_id":"","url":"https://api.github.com/users/Hideyuki-Yamashita","html_url":"https://github.com/Hideyuki-Yamashita","followers_url":"https://api.github.com/users/Hideyuki-Yamashita/followers","following_url":"https://api.github.com/users/Hideyuki-Yamashita/following{/other_user}","gists_url":"https://api.github.com/users/Hideyuki-Yamashita/gists{/gist_id}","starred_url":"https://api.github.com/users/Hideyuki-Yamashita/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Hideyuki-Yamashita/subscriptions","organizations_url":"https://api.github.com/users/Hideyuki-Yamashita/orgs","repos_url":"https://api.github.com/users/Hideyuki-Yamashita/repos","events_url":"https://api.github.com/users/Hideyuki-Yamashita/events{/privacy}","received_events_url":"https://api.github.com/users/Hideyuki-Yamashita/received_events","type":"User","site_admin":false},"body":"以下をファイル名の例の後に追加します。\r\n\r\n<pre>\r\nThis example shows that ``receiver`` thread receives ``start`` command at 20181108110600.  Port is ring:0, wcore_num is 1 and sequential number is 2.\r\n</pre>","created_at":"2018-12-28T12:04:34Z","updated_at":"2018-12-28T12:04:34Z","html_url":"https://github.com/ntt-ns/spp/pull/22#discussion_r244309037","pull_request_url":"https://api.github.com/repos/ntt-ns/spp/pulls/22","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/ntt-ns/spp/pulls/comments/244309037"},"html":{"href":"https://github.com/ntt-ns/spp/pull/22#discussion_r244309037"},"pull_request":{"href":"https://api.github.com/repos/ntt-ns/spp/pulls/22"}},"in_reply_to_id":244258655},"pull_request":{"url":"https://api.github.com/repos/ntt-ns/spp/pulls/22","id":240365424,"node_id":"MDExOlB1bGxSZXF1ZXN0MjQwMzY1NDI0","html_url":"https://github.com/ntt-ns/spp/pull/22","diff_url":"https://github.com/ntt-ns/spp/pull/22.diff","patch_url":"https://github.com/ntt-ns/spp/pull/22.patch","issue_url":"https://api.github.com/repos/ntt-ns/spp/issues/22","number":22,"state":"open","locked":false,"title":"Pcapドキュメント修正版","user":{"login":"Hideyuki-Yamashita","id":38413306,"node_id":"MDQ6VXNlcjM4NDEzMzA2","avatar_url":"https://avatars2.githubusercontent.com/u/38413306?v=4","gravatar_id":"","url":"https://api.github.com/users/Hideyuki-Yamashita","html_url":"https://github.com/Hideyuki-Yamashita","followers_url":"https://api.github.com/users/Hideyuki-Yamashita/followers","following_url":"https://api.github.com/users/Hideyuki-Yamashita/following{/other_user}","gists_url":"https://api.github.com/users/Hideyuki-Yamashita/gists{/gist_id}","starred_url":"https://api.github.com/users/Hideyuki-Yamashita/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Hideyuki-Yamashita/subscriptions","organizations_url":"https://api.github.com/users/Hideyuki-Yamashita/orgs","repos_url":"https://api.github.com/users/Hideyuki-Yamashita/repos","events_url":"https://api.github.com/users/Hideyuki-Yamashita/events{/privacy}","received_events_url":"https://api.github.com/users/Hideyuki-Yamashita/received_events","type":"User","site_admin":false},"body":"修正版をPull Requestします。\r\n対応ドキュメントは\r\nhttps://txdocsppreadthedocsio.readthedocs.io/en/draft_doc_feature_pcap/spp_pcap/index.html\r\nに配置しております。コメントよろしくお願いします。","created_at":"2018-12-21T03:52:20Z","updated_at":"2018-12-28T12:04:34Z","closed_at":null,"merged_at":null,"merge_commit_sha":"375212a181724f3a1e8d6a60b96221fd25ce06f3","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/ntt-ns/spp/pulls/22/commits","review_comments_url":"https://api.github.com/repos/ntt-ns/spp/pulls/22/comments","review_comment_url":"https://api.github.com/repos/ntt-ns/spp/pulls/comments{/number}","comments_url":"https://api.github.com/repos/ntt-ns/spp/issues/22/comments","statuses_url":"https://api.github.com/repos/ntt-ns/spp/statuses/07276ce3c05b2402e3281c2febd94ab95a5f8124","head":{"label":"ntt-ns:draft_doc_feature_pcap","ref":"draft_doc_feature_pcap","sha":"07276ce3c05b2402e3281c2febd94ab95a5f8124","user":{"login":"ntt-ns","id":29083414,"node_id":"MDEyOk9yZ2FuaXphdGlvbjI5MDgzNDE0","avatar_url":"https://avatars3.githubusercontent.com/u/29083414?v=4","gravatar_id":"","url":"https://api.github.com/users/ntt-ns","html_url":"https://github.com/ntt-ns","followers_url":"https://api.github.com/users/ntt-ns/followers","following_url":"https://api.github.com/users/ntt-ns/following{/other_user}","gists_url":"https://api.github.com/users/ntt-ns/gists{/gist_id}","starred_url":"https://api.github.com/users/ntt-ns/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ntt-ns/subscriptions","organizations_url":"https://api.github.com/users/ntt-ns/orgs","repos_url":"https://api.github.com/users/ntt-ns/repos","events_url":"https://api.github.com/users/ntt-ns/events{/privacy}","received_events_url":"https://api.github.com/users/ntt-ns/received_events","type":"Organization","site_admin":false},"repo":{"id":139083563,"node_id":"MDEwOlJlcG9zaXRvcnkxMzkwODM1NjM=","name":"spp","full_name":"ntt-ns/spp","private":false,"owner":{"login":"ntt-ns","id":29083414,"node_id":"MDEyOk9yZ2FuaXphdGlvbjI5MDgzNDE0","avatar_url":"https://avatars3.githubusercontent.com/u/29083414?v=4","gravatar_id":"","url":"https://api.github.com/users/ntt-ns","html_url":"https://github.com/ntt-ns","followers_url":"https://api.github.com/users/ntt-ns/followers","following_url":"https://api.github.com/users/ntt-ns/following{/other_user}","gists_url":"https://api.github.com/users/ntt-ns/gists{/gist_id}","starred_url":"https://api.github.com/users/ntt-ns/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ntt-ns/subscriptions","organizations_url":"https://api.github.com/users/ntt-ns/orgs","repos_url":"https://api.github.com/users/ntt-ns/repos","events_url":"https://api.github.com/users/ntt-ns/events{/privacy}","received_events_url":"https://api.github.com/users/ntt-ns/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/ntt-ns/spp","description":"Soft Patch Panel","fork":false,"url":"https://api.github.com/repos/ntt-ns/spp","forks_url":"https://api.github.com/repos/ntt-ns/spp/forks","keys_url":"https://api.github.com/repos/ntt-ns/spp/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ntt-ns/spp/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ntt-ns/spp/teams","hooks_url":"https://api.github.com/repos/ntt-ns/spp/hooks","issue_events_url":"https://api.github.com/repos/ntt-ns/spp/issues/events{/number}","events_url":"https://api.github.com/repos/ntt-ns/spp/events","assignees_url":"https://api.github.com/repos/ntt-ns/spp/assignees{/user}","branches_url":"https://api.github.com/repos/ntt-ns/spp/branches{/branch}","tags_url":"https://api.github.com/repos/ntt-ns/spp/tags","blobs_url":"https://api.github.com/repos/ntt-ns/spp/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ntt-ns/spp/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ntt-ns/spp/git/refs{/sha}","trees_url":"https://api.github.com/repos/ntt-ns/spp/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ntt-ns/spp/statuses/{sha}","languages_url":"https://api.github.com/repos/ntt-ns/spp/languages","stargazers_url":"https://api.github.com/repos/ntt-ns/spp/stargazers","contributors_url":"https://api.github.com/repos/ntt-ns/spp/contributors","subscribers_url":"https://api.github.com/repos/ntt-ns/spp/subscribers","subscription_url":"https://api.github.com/repos/ntt-ns/spp/subscription","commits_url":"https://api.github.com/repos/ntt-ns/spp/commits{/sha}","git_commits_url":"https://api.github.com/repos/ntt-ns/spp/git/commits{/sha}","comments_url":"https://api.github.com/repos/ntt-ns/spp/comments{/number}","issue_comment_url":"https://api.github.com/repos/ntt-ns/spp/issues/comments{/number}","contents_url":"https://api.github.com/repos/ntt-ns/spp/contents/{+path}","compare_url":"https://api.github.com/repos/ntt-ns/spp/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ntt-ns/spp/merges","archive_url":"https://api.github.com/repos/ntt-ns/spp/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ntt-ns/spp/downloads","issues_url":"https://api.github.com/repos/ntt-ns/spp/issues{/number}","pulls_url":"https://api.github.com/repos/ntt-ns/spp/pulls{/number}","milestones_url":"https://api.github.com/repos/ntt-ns/spp/milestones{/number}","notifications_url":"https://api.github.com/repos/ntt-ns/spp/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ntt-ns/spp/labels{/name}","releases_url":"https://api.github.com/repos/ntt-ns/spp/releases{/id}","deployments_url":"https://api.github.com/repos/ntt-ns/spp/deployments","created_at":"2018-06-29T00:55:20Z","updated_at":"2018-12-28T02:55:06Z","pushed_at":"2018-12-28T07:40:03Z","git_url":"git://github.com/ntt-ns/spp.git","ssh_url":"git@github.com:ntt-ns/spp.git","clone_url":"https://github.com/ntt-ns/spp.git","svn_url":"https://github.com/ntt-ns/spp","homepage":null,"size":954,"stargazers_count":3,"watchers_count":3,"language":"C","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":5,"license":null,"forks":0,"open_issues":5,"watchers":3,"default_branch":"master"}},"base":{"label":"ntt-ns:master","ref":"master","sha":"388819af496cbf7e685e01939fa99b6e952466bc","user":{"login":"ntt-ns","id":29083414,"node_id":"MDEyOk9yZ2FuaXphdGlvbjI5MDgzNDE0","avatar_url":"https://avatars3.githubusercontent.com/u/29083414?v=4","gravatar_id":"","url":"https://api.github.com/users/ntt-ns","html_url":"https://github.com/ntt-ns","followers_url":"https://api.github.com/users/ntt-ns/followers","following_url":"https://api.github.com/users/ntt-ns/following{/other_user}","gists_url":"https://api.github.com/users/ntt-ns/gists{/gist_id}","starred_url":"https://api.github.com/users/ntt-ns/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ntt-ns/subscriptions","organizations_url":"https://api.github.com/users/ntt-ns/orgs","repos_url":"https://api.github.com/users/ntt-ns/repos","events_url":"https://api.github.com/users/ntt-ns/events{/privacy}","received_events_url":"https://api.github.com/users/ntt-ns/received_events","type":"Organization","site_admin":false},"repo":{"id":139083563,"node_id":"MDEwOlJlcG9zaXRvcnkxMzkwODM1NjM=","name":"spp","full_name":"ntt-ns/spp","private":false,"owner":{"login":"ntt-ns","id":29083414,"node_id":"MDEyOk9yZ2FuaXphdGlvbjI5MDgzNDE0","avatar_url":"https://avatars3.githubusercontent.com/u/29083414?v=4","gravatar_id":"","url":"https://api.github.com/users/ntt-ns","html_url":"https://github.com/ntt-ns","followers_url":"https://api.github.com/users/ntt-ns/followers","following_url":"https://api.github.com/users/ntt-ns/following{/other_user}","gists_url":"https://api.github.com/users/ntt-ns/gists{/gist_id}","starred_url":"https://api.github.com/users/ntt-ns/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ntt-ns/subscriptions","organizations_url":"https://api.github.com/users/ntt-ns/orgs","repos_url":"https://api.github.com/users/ntt-ns/repos","events_url":"https://api.github.com/users/ntt-ns/events{/privacy}","received_events_url":"https://api.github.com/users/ntt-ns/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/ntt-ns/spp","description":"Soft Patch Panel","fork":false,"url":"https://api.github.com/repos/ntt-ns/spp","forks_url":"https://api.github.com/repos/ntt-ns/spp/forks","keys_url":"https://api.github.com/repos/ntt-ns/spp/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ntt-ns/spp/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ntt-ns/spp/teams","hooks_url":"https://api.github.com/repos/ntt-ns/spp/hooks","issue_events_url":"https://api.github.com/repos/ntt-ns/spp/issues/events{/number}","events_url":"https://api.github.com/repos/ntt-ns/spp/events","assignees_url":"https://api.github.com/repos/ntt-ns/spp/assignees{/user}","branches_url":"https://api.github.com/repos/ntt-ns/spp/branches{/branch}","tags_url":"https://api.github.com/repos/ntt-ns/spp/tags","blobs_url":"https://api.github.com/repos/ntt-ns/spp/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ntt-ns/spp/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ntt-ns/spp/git/refs{/sha}","trees_url":"https://api.github.com/repos/ntt-ns/spp/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ntt-ns/spp/statuses/{sha}","languages_url":"https://api.github.com/repos/ntt-ns/spp/languages","stargazers_url":"https://api.github.com/repos/ntt-ns/spp/stargazers","contributors_url":"https://api.github.com/repos/ntt-ns/spp/contributors","subscribers_url":"https://api.github.com/repos/ntt-ns/spp/subscribers","subscription_url":"https://api.github.com/repos/ntt-ns/spp/subscription","commits_url":"https://api.github.com/repos/ntt-ns/spp/commits{/sha}","git_commits_url":"https://api.github.com/repos/ntt-ns/spp/git/commits{/sha}","comments_url":"https://api.github.com/repos/ntt-ns/spp/comments{/number}","issue_comment_url":"https://api.github.com/repos/ntt-ns/spp/issues/comments{/number}","contents_url":"https://api.github.com/repos/ntt-ns/spp/contents/{+path}","compare_url":"https://api.github.com/repos/ntt-ns/spp/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ntt-ns/spp/merges","archive_url":"https://api.github.com/repos/ntt-ns/spp/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ntt-ns/spp/downloads","issues_url":"https://api.github.com/repos/ntt-ns/spp/issues{/number}","pulls_url":"https://api.github.com/repos/ntt-ns/spp/pulls{/number}","milestones_url":"https://api.github.com/repos/ntt-ns/spp/milestones{/number}","notifications_url":"https://api.github.com/repos/ntt-ns/spp/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ntt-ns/spp/labels{/name}","releases_url":"https://api.github.com/repos/ntt-ns/spp/releases{/id}","deployments_url":"https://api.github.com/repos/ntt-ns/spp/deployments","created_at":"2018-06-29T00:55:20Z","updated_at":"2018-12-28T02:55:06Z","pushed_at":"2018-12-28T07:40:03Z","git_url":"git://github.com/ntt-ns/spp.git","ssh_url":"git@github.com:ntt-ns/spp.git","clone_url":"https://github.com/ntt-ns/spp.git","svn_url":"https://github.com/ntt-ns/spp","homepage":null,"size":954,"stargazers_count":3,"watchers_count":3,"language":"C","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":5,"license":null,"forks":0,"open_issues":5,"watchers":3,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/ntt-ns/spp/pulls/22"},"html":{"href":"https://github.com/ntt-ns/spp/pull/22"},"issue":{"href":"https://api.github.com/repos/ntt-ns/spp/issues/22"},"comments":{"href":"https://api.github.com/repos/ntt-ns/spp/issues/22/comments"},"review_comments":{"href":"https://api.github.com/repos/ntt-ns/spp/pulls/22/comments"},"review_comment":{"href":"https://api.github.com/repos/ntt-ns/spp/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/ntt-ns/spp/pulls/22/commits"},"statuses":{"href":"https://api.github.com/repos/ntt-ns/spp/statuses/07276ce3c05b2402e3281c2febd94ab95a5f8124"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"Hideyuki-Yamashita"}}