Comment getUnderlyingAddressRoot.

atrick · atrick · commit 806ef0f5c870 · 2018-01-08T11:29:47.000-08:00
diff --git a/lib/SIL/InstructionUtils.cpp b/lib/SIL/InstructionUtils.cpp
@@ -33,6 +33,9 @@ SILValue swift::getUnderlyingObject(SILValue V) {
   }
 }
 
+/// Strip off casts and address projections into the interior of a value. Unlike
+/// getUnderlyingObject, this does not find the root of a heap object--a class
+/// property is itself an address root.
 SILValue swift::getUnderlyingAddressRoot(SILValue V) {
   while (true) {
     SILValue V2 = stripIndexingInsts(stripCasts(V));

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,9 @@ SILValue swift::getUnderlyingObject(SILValue V) {`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`
	`36`	`+/// Strip off casts and address projections into the interior of a value. Unlike`
	`37`	`+/// getUnderlyingObject, this does not find the root of a heap object--a class`
	`38`	`+/// property is itself an address root.`
`36`	`39`	`SILValue swift::getUnderlyingAddressRoot(SILValue V) {`
`37`	`40`	`while (true) {`
`38`	`41`	`SILValue V2 = stripIndexingInsts(stripCasts(V));`