Skip to content

[SPARK-22603][SQL] Fix 64KB JVM bytecode limit problem with FormatString #19817

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kiszk wants to merge 2 commits into from
Closed

[SPARK-22603][SQL] Fix 64KB JVM bytecode limit problem with FormatString #19817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5bcbc4
initial commit
kiszk Nov 24, 2017
84c8bf4
address review comment
kiszk Nov 24, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions ...catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/stringExpressions.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1372,19 +1372,30 @@ case class FormatString(children: Expression*) extends Expression with ImplicitC
val pattern = children.head.genCode(ctx)

val argListGen = children.tail.map(x => (x.dataType, x.genCode(ctx)))
val argListCode = argListGen.map(_._2.code + "\n")

val argListString = argListGen.foldLeft("")((s, v) => {
val nullSafeString =
val argList = ctx.freshName("argLists")
val numArgLists = argListGen.length
val argListCode = argListGen.zipWithIndex.map { case(v, index) =>
val value =
if (ctx.boxedType(v._1) != ctx.javaType(v._1)) {
// Java primitives get boxed in order to allow null values.
s"(${v._2.isNull}) ? (${ctx.boxedType(v._1)}) null : " +
s"new ${ctx.boxedType(v._1)}(${v._2.value})"
} else {
s"(${v._2.isNull}) ? null : ${v._2.value}"
}
s + "," + nullSafeString
})
s"""
${v._2.code}
$argList[$index] = $value;
"""
}
val argListCodes = if (ctx.INPUT_ROW != null && ctx.currentVars == null) {
ctx.splitExpressions(
expressions = argListCode,
funcName = "valueFormatString",
arguments = ("InternalRow", ctx.INPUT_ROW) :: ("Object[]", argList) :: Nil)
} else {
argListCode.mkString("\n")
}

@gatorsmile gatorsmile Nov 26, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you create a splitExpressions in CodegenContext for avoiding the duplicate codes, like

    if (ctx.INPUT_ROW != null && ctx.currentVars == null) {
      ctx.splitExpressions(...)
    } else {
      inputs.mkString("\n")
    }

@kiszk kiszk Nov 26, 2017 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, is it better to do this in this PR? Or, should I create another PR?

@mgaido91 mgaido91 Nov 26, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to submit a PR for that, but I was waiting for all the PRs related (this one should be the last one) to be merged. Let me know if I can do that or you are doing it. My suggestion would be: can't we just change the existing method to include this check?

@kiszk kiszk Nov 26, 2017 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your comment. After writing the above comment, I thought it would be good to create a separate PR.
Thus, I have just submitted a PR #19821 as WIP before I read your comment. That PR should wait for merging this PR and then I will do rebase for #19821.


val form = ctx.freshName("formatter")
val formatter = classOf[java.util.Formatter].getName
Expand All @@ -1395,10 +1406,11 @@ case class FormatString(children: Expression*) extends Expression with ImplicitC
boolean ${ev.isNull} = ${pattern.isNull};
${ctx.javaType(dataType)} ${ev.value} = ${ctx.defaultValue(dataType)};
if (!${ev.isNull}) {
${argListCode.mkString}
$stringBuffer $sb = new $stringBuffer();
$formatter $form = new $formatter($sb, ${classOf[Locale].getName}.US);
$form.format(${pattern.value}.toString() $argListString);
Object[] $argList = new Object[$numArgLists];
$argListCodes
$form.format(${pattern.value}.toString(), $argList);
${ev.value} = UTF8String.fromString($sb.toString());
}""")
}
Expand Down
8 changes: 8 additions & 0 deletions ...yst/src/test/scala/org/apache/spark/sql/catalyst/expressions/StringExpressionsSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,6 +518,14 @@ class StringExpressionsSuite extends SparkFunSuite with ExpressionEvalHelper {
FormatString(Literal("aa%d%s"), 12, Literal.create(null, StringType)), "aa12null")
}

test("SPARK-22603: FormatString should not generate codes beyond 64KB") {
val N = 4500
val args = (1 to N).map(i => Literal.create(i.toString, StringType))
val format = "%s" * N
val expected = (1 to N).map(i => i.toString).mkString
checkEvaluation(FormatString(Literal(format) +: args: _*), expected)
}

test("INSTR") {
val s1 = 'a.string.at(0)
val s2 = 'b.string.at(1)
Expand Down