interfaces/builtin: implement broadcom-asic-control interface #3623

morphis · 2017-07-26T10:15:02Z

This implements a new interface necessary to access certain device nodes exposed by the kernel drivers from Broadcom for their ASIC on switch devices.

This requires specific kernel modules to be available and loaded which will be soon shipped with the official Ubuntu kernel.

…trol-iface

Descriptions will be managed on the forum real soon so there is no need store it inside the code anymore.

…ntrol

morphis · 2017-07-26T15:43:12Z

Support for kernel modules was now added.

jhodapp

Just a couple of things I'm curious about.

jhodapp · 2017-07-26T19:15:52Z

interfaces/builtin/broadcom-asic-control.go

+	}
+
+	// Creation of the slot of this type is allowed only by a gadget or os snap
+	if !(slot.Snap.Type == "os") {


This hasn't been changed to being called "core" instead of "os"?

The type of a core snap is still "os". See https://github.com/snapcore/snapd/blob/master/snap/types.go#L31 for details

Sounds like a bug in snapd that should be fixed before there's hundreds or thousands of interfaces.

You will be happy to learn I fixed this a moment ago :)

jhodapp · 2017-07-26T19:18:25Z

interfaces/builtin/broadcom-asic-control.go

+    allow-installation:
+      slot-snap-type:
+        - core
+    deny-auto-connection: true


What's the difference between this and line 145 returning true for the AutoConnect method?

See the comment in https://github.com/snapcore/snapd/pull/3623/files#diff-7657fbc6427572b16bb91d9568774554R144

AutoConnect is more or less a relict from older times. Base declaration has priority.

Ah yes, I forgot to comment on that comment. :) It didn't make sense to me. Can you reword that comment on line 144?

What doesn't make sense? It's the same comment used on all other interfaces for the AutoConnect method.

So the comment states this:

// Allow what is allowed in the declarations

Maybe if you point to where the reader of the code could know what exactly is allowed, then it'd make more sense to me. It's just too general of a comment to add much value in my opinion.

…ic-control-iface

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>

zyga · 2017-07-28T15:22:35Z

I pushed some API changes and cleanups.

zyga

I pushed API cleanups and did a small review of the code. I think you need an ack from @jdstrand to land this and a review from @niemeyer on the ImplicitOnClassic flag.

zyga · 2017-07-28T15:24:02Z

interfaces/builtin/broadcom_asic_control.go

+	return interfaces.StaticInfo{
+		Summary:              broadcomAsicControlSummary,
+		ImplicitOnCore:       true,
+		ImplicitOnClassic:    true,


I wonder if this should be implicit on classic where it will show up for nearly everyone. It feels like a thing that we could do via classic gadgets if it is really needed there. WDYT?

I think that this interface is very similar to dcdbas-control, which is implicit classic, and therefore we shouldn't make this PR do something else. If we want to clean this up and make conditional on gadgets, etc, that could be a future improvement.

zyga · 2017-07-28T15:24:57Z

interfaces/builtin/broadcom_asic_control_test.go

+`
+
+func (s *BroadcomAsicControlSuite) SetUpTest(c *C) {
+	s.slot = &interfaces.Slot{


Can you please just declare more snaps like you did above? I'd much rather see snaptest.MockInfo than hand-made structures.

zyga · 2017-07-28T15:25:39Z

interfaces/builtin/broadcom_asic_control_test.go

+	c.Assert(s.plug.Sanitize(s.iface), IsNil)
+}
+
+func (s *BroadcomAsicControlSuite) TestUsedSecuritySystems(c *C) {


Can you please split this per backend. It will be easier to follow and you can use some shorter variable names (e.g. spec instead of apparmorSpec).

jhodapp · 2017-07-28T16:59:57Z

@zyga @jdstrand Can we have someone else review the ImplicitOnClassic flag usage since Gustavo is out for the next week? We need to keep this review rolling and merged so it gets into the next possible snapd release.

Thanks for staying on top of this review @zyga

jdstrand

The base declaration, apparmor policy, udev rules and kernel modules all look ok, but please make the requested policy changes.

jdstrand · 2017-07-28T18:04:41Z

interfaces/builtin/broadcom_asic_control.go

+/sys/module/linux_bcm_knet/refcnt r,
+/dev/linux-user-bde rw,
+/dev/linux-kernel-bde rw,
+/dev/linux-bcm-knet wr,


For consistency, please use 'rw' here.

jdstrand · 2017-07-28T18:06:54Z

interfaces/builtin/broadcom_asic_control.go

+/sys/module/linux_user_bde/refcnt r,
+/sys/module/linux_bcm_knet/initstate r,
+/sys/module/linux_bcm_knet/holders/ r,
+/sys/module/linux_bcm_knet/refcnt r,


Since these are all only reads, I think the above can all be collapsed into (which is easier to read and futureproof):

/sys/module/linux_bcm_knet/{,**} r, /sys/module/linux_kernel_bde/{,**} r, /sys/module/linux_user_bde/{,**} r,

jdstrand · 2017-07-28T18:10:22Z

interfaces/builtin/broadcom_asic_control.go

+	return interfaces.StaticInfo{
+		Summary:              broadcomAsicControlSummary,
+		ImplicitOnCore:       true,
+		ImplicitOnClassic:    true,


I think that this interface is very similar to dcdbas-control, which is implicit classic, and therefore we shouldn't make this PR do something else. If we want to clean this up and make conditional on gadgets, etc, that could be a future improvement.

jhodapp · 2017-07-28T19:32:17Z

@jdstrand Your last comment about implicit classic I don't quite follow. Are you simply stating that it doesn't need any special review/permission in order to use implicit classic before it gets merged, or something else?

jhodapp

I'm happy now, looks very good!

jdstrand · 2017-07-31T14:10:57Z

@jhodapp - I was saying that I don't think the implicit parts of this interface need to change.

jdstrand

The security policy changes look good, thanks.

codecov-io · 2017-07-31T14:18:18Z

Codecov Report

Merging #3623 into master will increase coverage by 0.02%.
The diff coverage is 91.17%.

@@            Coverage Diff             @@
##           master    #3623      +/-   ##
==========================================
+ Coverage   75.19%   75.21%   +0.02%     
==========================================
  Files         386      387       +1     
  Lines       33418    33452      +34     
==========================================
+ Hits        25127    25162      +35     
+ Misses       6480     6478       -2     
- Partials     1811     1812       +1

Impacted Files	Coverage Δ
interfaces/builtin/broadcom_asic_control.go	`91.17% <91.17%> (ø)`
overlord/ifacestate/helpers.go	`63% <0%> (+0.66%)`	⬆️
interfaces/sorting.go	`100% <0%> (+1.28%)`	⬆️
cmd/snap/cmd_aliases.go	`95% <0%> (+1.66%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1bb7d6d...1005db0. Read the comment docs.

jhodapp · 2017-08-01T01:50:55Z

@zyga can you approve this and merge please?

zyga

LGTM

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>

knitzsche and others added 4 commits July 21, 2017 09:12

add broadcom-asic-control interface

b72277e

Merge remote-tracking branch 'origin/master' into f/broadcom-asic-con…

0761be1

…trol-iface

interfaces/builtin: rework broadcom-asic-control to use udev tagging

7f18146

interfaces/builtin: get rid of description for broadcom-asic-control

7054363

Descriptions will be managed on the forum real soon so there is no need store it inside the code anymore.

morphis mentioned this pull request Jul 26, 2017

add broadcom-asic-control interface #3615

Closed

interfaces/builtin: add necessary kernel modules for broadcom-asic-co…

9901357

…ntrol

jhodapp suggested changes Jul 26, 2017

View reviewed changes

zyga added 6 commits July 28, 2017 17:16

Merge branch 'master' of github.com:snapcore/snapd into f/broadcom-as…

b67187a

…ic-control-iface

interfaces: rename new files to under_score naming scheme

cb4b3a5

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>

interfaces: remove redundant interface type checks

bd99c29

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>

interfaces: remove unused SanitizePlug method

dd18aae

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>

interfaces: use helper for slot validation

187a127

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>

interfaces: discard the unnecessary String method

18703e7

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>

zyga reviewed Jul 28, 2017

View reviewed changes

jdstrand reviewed Jul 28, 2017

View reviewed changes

morphis added 2 commits July 31, 2017 15:00

Respect review comments

23a6830

Add link to description of our base declaration as requested in review

b4ae984

jhodapp approved these changes Jul 31, 2017

View reviewed changes

jdstrand approved these changes Jul 31, 2017

View reviewed changes

zyga approved these changes Aug 1, 2017

View reviewed changes

zyga added 3 commits August 1, 2017 08:55

interfaces: bump copyright

5b5cbb7

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>

interfaces: shorten error handling code

c4fce5d

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>

interfaces: improve tests for broadcom-asic-control

1005db0

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>

zyga merged commit 5d4d540 into snapcore:master Aug 1, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

interfaces/builtin: implement broadcom-asic-control interface #3623

interfaces/builtin: implement broadcom-asic-control interface #3623

morphis commented Jul 26, 2017 •

edited

morphis commented Jul 26, 2017

jhodapp left a comment

jhodapp Jul 26, 2017

morphis Jul 26, 2017

jhodapp Jul 26, 2017

zyga Jul 28, 2017

jhodapp Jul 28, 2017

jhodapp Jul 26, 2017

morphis Jul 26, 2017

jhodapp Jul 26, 2017

morphis Jul 28, 2017

jhodapp Jul 28, 2017

zyga commented Jul 28, 2017

zyga left a comment

zyga Jul 28, 2017

jdstrand Jul 28, 2017

zyga Jul 28, 2017

morphis Jul 31, 2017

zyga Jul 28, 2017

morphis Jul 31, 2017

jhodapp commented Jul 28, 2017 •

edited

jdstrand left a comment

jdstrand Jul 28, 2017

morphis Jul 31, 2017

jdstrand Jul 28, 2017

morphis Jul 31, 2017

jdstrand Jul 28, 2017

jhodapp commented Jul 28, 2017

jhodapp left a comment

jdstrand commented Jul 31, 2017

jdstrand left a comment

codecov-io commented Jul 31, 2017 •

edited

jhodapp commented Aug 1, 2017

zyga left a comment

interfaces/builtin: implement broadcom-asic-control interface #3623

interfaces/builtin: implement broadcom-asic-control interface #3623

Conversation

morphis commented Jul 26, 2017 • edited

morphis commented Jul 26, 2017

jhodapp left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zyga commented Jul 28, 2017

zyga left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jhodapp commented Jul 28, 2017 • edited

jdstrand left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jhodapp commented Jul 28, 2017

jhodapp left a comment

Choose a reason for hiding this comment

jdstrand commented Jul 31, 2017

jdstrand left a comment

Choose a reason for hiding this comment

codecov-io commented Jul 31, 2017 • edited

Codecov Report

jhodapp commented Aug 1, 2017

zyga left a comment

Choose a reason for hiding this comment

morphis commented Jul 26, 2017 •

edited

jhodapp commented Jul 28, 2017 •

edited

codecov-io commented Jul 31, 2017 •

edited