[Windows] Onboard Envoy to SCM by davinci26 · Pull Request #14352 · envoyproxy/envoy

davinci26 · 2020-12-09T21:23:58Z

Signed-off-by: Sotiris Nanopoulos sonanopo@microsoft.com
Commit Message:
Fixes #13188

Additional Description:

Utilizes the same inter process communication as signal_impl to handle close.

Pending work:

Add tests
Add documentation on how to use the feature

Risk Level: Low (Windows Only)
Testing: Unit/Integration

Docs Changes: Added on how to run Envoy
Release Notes: N/A

davinci26 · 2020-12-09T21:24:52Z

Creating as draft to have an idea of what the CI is thinking and get some early feedback

davinci26 · 2020-12-09T21:26:09Z

@envoyproxy/windows-dev want to do an early pass to see if this going to the correct direction?

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

source/exe/main_common.cc

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

examples/mysql/envoy.yaml

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

bazel/envoy_binary.bzl

sunjayBhatia

First high level pass looks good overall, some changes requested in comments

source/exe/win32/service_base.cc

source/exe/win32/service_base.h

test/exe/win32_scm_test.cc

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

davinci26 · 2020-12-14T17:00:19Z

/retest

repokitteh-read-only · 2020-12-14T17:00:26Z

Retrying Azure Pipelines:
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #14352 (comment) was created by @davinci26.

see: more, trace.

davinci26 · 2020-12-14T17:34:31Z

@wrowe this is ready for review. Please take a look when you have time

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

davinci26 · 2021-01-12T18:06:18Z

@wrowe can we get this on track to get merged since 1.17 is out now

davinci26 · 2021-01-23T00:02:35Z

@wrowe just a ping for a review

wrowe

Re-reviewed with two key concerns, the suggested sc.exe args, and whether we want to utilize preshutdown, see the description of preshutdown in https://docs.microsoft.com/en-us/windows/win32/services/service-control-handler-function

source/exe/win32/service_base.h

docs/root/start/quick-start/run-envoy.rst

source/exe/win32/service_base.cc

docs/root/start/quick-start/run-envoy.rst

Signed-off-by: davinci26 <sotirisnan@gmail.com>

wrowe

LGTM thanks for the contribution and iterating through all our nits.

@envoyproxy/senior-maintainers could someone give this new facility a final pass?

davinci26 · 2021-02-23T17:00:22Z

@envoyproxy/senior-maintainers anyone interested in reviewing this one?

davinci26 · 2021-02-26T18:17:02Z

@envoyproxy/senior-maintainers anyone interested in doing a win32 code review to get this one merged?

mattklein123 · 2021-02-27T18:45:45Z

I can take a look.

mattklein123

LGTM at a high level (I skimmed the win32 code) with some small comments. Thank you!

/wait

source/exe/BUILD

source/exe/main_common.h

source/exe/win32/service_base.cc

Signed-off-by: davinci26 <sotirisnan@gmail.com>

mattklein123

Thanks!

davinci26 · 2021-03-04T16:48:38Z

picking up main to fix the CI

htuch · 2021-03-11T03:31:59Z

source/exe/win32/service_base.cc

+  char data[] = {'a'};
+  Buffer::RawSlice buffer{data, 1};
+  auto result = handler->writev(&buffer, 1);
+  RELEASE_ASSERT(result.rc_ == 1,


@davinci26 how come we are using RELEASE_ASSERT here for error handling? This doesn't match error handling policy in https://github.com/envoyproxy/envoy/blob/main/STYLE.md#error-handling I believe. CC @asraa

Or maybe it's fine because you are on the way out anyway? I'd be interested in your take @davinci26 on all the RELEASE_ASSERTs in this module relative to the policy. I actually think it might be fine, but it's hard to tell without understanding the Windows API expectations.

Or maybe it's fine because you are on the way out anyway?

Exactly, we have already received a SIGTERM from the service control manager which means that for some reason we need to shutdown anyway. We try to do it in a graceful way but if the write fails we might as well crash.

The rest of the release asserts are guarding against a developer shooting themselves at the foot. i.e. someone manually calling delete the pointers on the global scope. I added the release asserts for them based on or an obvious crash on a subsequent line via null pointer dereference.. No strong opinion though.

Do you want me to document these in code with comments so it's clear for anyone reading the code?

jiangkaihua · 2021-04-15T08:49:17Z

source/exe/main.cc

 #include "exe/main_common.h"

+#ifdef WIN32
+#include "exe/service_base.h"


I am a new hand to envoy, but there seems no service_base.h header file in ./source/exe/. Should it be #include "exe/win32/service_base.h"?

Are you encountering any issues compiling this or just curious? We use the strip_prefix tag on here https://github.com/davinci26/envoy/blob/6650ba0799592927005f59fc00472ce67c03da37/source/exe/BUILD#L196 and this is why win32 is not needed

Just curious about it, thanks a lot for your help : )

No prob, happy to help.

davinci26 added the area/windows label Dec 9, 2020

scm initial impl

207e376

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

davinci26 force-pushed the scm2 branch from e228ff4 to 207e376 Compare December 9, 2020 21:59

davinci26 assigned wrowe Dec 9, 2020

davinci26 commented Dec 9, 2020

View reviewed changes

source/exe/main_common.cc Outdated Show resolved Hide resolved

adds test

e83f55b

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

davinci26 commented Dec 11, 2020

View reviewed changes

examples/mysql/envoy.yaml Outdated Show resolved Hide resolved

Sotiris Nanopoulos added 3 commits December 10, 2020 16:59

adds documentation

b96ed04

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

fix format

e82dc54

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

fix documentation

6766c9a

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

davinci26 marked this pull request as ready for review December 11, 2020 01:50

sunjayBhatia reviewed Dec 11, 2020

View reviewed changes

bazel/envoy_binary.bzl Show resolved Hide resolved

sunjayBhatia suggested changes Dec 11, 2020

View reviewed changes

source/exe/win32/service_base.cc Show resolved Hide resolved

source/exe/win32/service_base.cc Outdated Show resolved Hide resolved

source/exe/win32/service_base.h Show resolved Hide resolved

test/exe/win32_scm_test.cc Show resolved Hide resolved

Sotiris Nanopoulos added 10 commits December 11, 2020 10:20

add more comments and some cleanup in unused parameters

aba15d9

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

Merge branch 'scm2' of https://github.com/davinci26/envoy into scm2

a753e67

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

fix unix build

2d49561

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

small test fix

cc0e28c

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

Trigger Build

7c4eb50

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

format

12f5325

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

fix posix compilation vol 2

ea368eb

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

format

5d1aed8

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

increase coverage

fe474b1

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

fix size error in tests

0859975

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

Sotiris Nanopoulos added 2 commits December 14, 2020 15:31

fix clang build

e7c2c41

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

remove the macro entirely

92a683f

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

improve docs

ad75015

Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>

Base automatically changed from master to main January 15, 2021 23:02

wrowe suggested changes Jan 25, 2021

View reviewed changes

source/exe/win32/service_base.h Outdated Show resolved Hide resolved

docs/root/start/quick-start/run-envoy.rst Outdated Show resolved Hide resolved

wrowe reviewed Jan 27, 2021

View reviewed changes

source/exe/win32/service_base.cc Show resolved Hide resolved

wrowe reviewed Jan 27, 2021

View reviewed changes

docs/root/start/quick-start/run-envoy.rst Outdated Show resolved Hide resolved

davinci26 added 2 commits February 11, 2021 09:50

Merge remote-tracking branch 'upstream/main' into scm2

439811b

Address PR comments

44ce57b

Signed-off-by: davinci26 <sotirisnan@gmail.com>

wrowe previously approved these changes Feb 17, 2021

View reviewed changes

wrowe added the enhancement Feature requests. Not bugs or questions. label Feb 17, 2021

wrowe added this to the 1.18.0 milestone Feb 17, 2021

mattklein123 self-assigned this Feb 27, 2021

mattklein123 requested changes Mar 1, 2021

View reviewed changes

source/exe/BUILD Outdated Show resolved Hide resolved

source/exe/main_common.h Outdated Show resolved Hide resolved

source/exe/win32/service_base.cc Outdated Show resolved Hide resolved

repokitteh-read-only bot added the waiting label Mar 1, 2021

fix PR comments from Matt

e6668dd

Signed-off-by: davinci26 <sotirisnan@gmail.com>

davinci26 dismissed wrowe’s stale review via e6668dd March 3, 2021 19:44

repokitteh-read-only bot removed the waiting label Mar 3, 2021

davinci26 added 2 commits March 3, 2021 12:47

fix build format

9ddf9b2

Signed-off-by: davinci26 <sotirisnan@gmail.com>

revert accidental change

c8f664a

Signed-off-by: davinci26 <sotirisnan@gmail.com>

mattklein123 approved these changes Mar 4, 2021

View reviewed changes

Merge remote-tracking branch 'upstream/main' into scm2

6650ba0

mattklein123 merged commit 207319e into envoyproxy:main Mar 4, 2021

htuch reviewed Mar 11, 2021

View reviewed changes

jiangkaihua reviewed Apr 15, 2021

View reviewed changes

Conversation

davinci26 commented Dec 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pending work:

Uh oh!

davinci26 commented Dec 9, 2020

Uh oh!

davinci26 commented Dec 9, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sunjayBhatia left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

davinci26 commented Dec 14, 2020

Uh oh!

repokitteh-read-only bot commented Dec 14, 2020

Uh oh!

davinci26 commented Dec 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

davinci26 commented Jan 12, 2021

Uh oh!

davinci26 commented Jan 23, 2021

Uh oh!

wrowe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wrowe left a comment

Choose a reason for hiding this comment

Uh oh!

davinci26 commented Feb 23, 2021

Uh oh!

davinci26 commented Feb 26, 2021

Uh oh!

mattklein123 commented Feb 27, 2021

Uh oh!

mattklein123 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mattklein123 left a comment

Choose a reason for hiding this comment

Uh oh!

davinci26 commented Mar 4, 2021

Uh oh!

htuch Mar 11, 2021

Choose a reason for hiding this comment

Uh oh!

htuch Mar 11, 2021

Choose a reason for hiding this comment

Uh oh!

davinci26 Mar 11, 2021

Choose a reason for hiding this comment

Uh oh!

jiangkaihua Apr 15, 2021

Choose a reason for hiding this comment

Uh oh!

davinci26 Apr 15, 2021

Choose a reason for hiding this comment

Uh oh!

jiangkaihua Apr 16, 2021

Choose a reason for hiding this comment

Uh oh!

davinci26 Apr 16, 2021

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

davinci26 commented Dec 9, 2020 •

edited

Loading

davinci26 commented Dec 14, 2020 •

edited

Loading