Skip to content
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

Support serializing large (> 2 GiB) annotation files #3905

Merged
merged 2 commits into from
Mar 5, 2024
Merged

Support serializing large (> 2 GiB) annotation files #3905

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
0ac2858
Support serializing Annotations to a Writer
jackkoenig Mar 5, 2024
86e2672
Serialize to Writer instead of String in WriteOutputAnnotations
jackkoenig Mar 5, 2024
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
17 changes: 13 additions & 4 deletions firrtl/src/main/scala/firrtl/annotations/JsonProtocol.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import org.json4s.native.Serialization
import org.json4s.native.Serialization.{read, write, writePretty}

import scala.collection.mutable
import java.io.{StringWriter, Writer}

trait HasSerializationHints {
// For serialization of complicated constructor arguments, let the annotation
Expand Down Expand Up @@ -167,13 +168,21 @@ object JsonProtocol extends LazyLogging {
})
.distinct

def serializeTry(annos: Seq[Annotation]): Try[String] = {
val tags = getTags(annos)
def serializeTry(annos: Seq[Annotation]): Try[String] = serializeTry(annos, new StringWriter).map(_.toString)

/** Serialize annotations to a [[java.io.Writer]]
*
* @param annos Annotations to serialize
* @param out Writer to which the serialized annotations will be written
* @return
*/
def serializeTry[W <: Writer](annos: Iterable[Annotation], out: W): Try[W] = {
Copy link
Member

Choose a reason for hiding this comment

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

An alternative is to make this private. There is then nothing to actually test here (other than seeing if 2GiB of annotations work... 😓). I'm really questioning if this is necessary to make public.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I assumed I'd have to call it from Chisel but ended up not needing to. That being said, the current test is in package firrtlTests so would have to mess with that. We have already deprecated any import of package firrtl (via the compiler plugin) so I'm a bit 🤷‍♀️ about it.

val tags = getTags(annos.toSeq)

implicit val formats = jsonFormat(tags)
Try(writePretty(annos)).recoverWith {
Try(writePretty(annos, out)).recoverWith {
case e: org.json4s.MappingException =>
val badAnnos = findUnserializeableAnnos(annos)
val badAnnos = findUnserializeableAnnos(annos.toSeq)
Failure(if (badAnnos.isEmpty) e else UnserializableAnnotationException(badAnnos))
}
}
Expand Down
2 changes: 1 addition & 1 deletion firrtl/src/main/scala/firrtl/options/phases/WriteOutputAnnotations.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ class WriteOutputAnnotations extends Phase {
case None =>
case Some(file) =>
val pw = new PrintWriter(sopts.getBuildFileName(file, Some(".anno.json")))
pw.write(JsonProtocol.serialize(serializable))
JsonProtocol.serializeTry(serializable, pw).get // .get to throw any exceptions
pw.close()
}
}
Expand Down
20 changes: 20 additions & 0 deletions firrtl/src/test/scala/firrtl/JsonProtocolSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,24 @@ class JsonProtocolSpec extends AnyFlatSpec {
val deserAnno = JsonProtocol.deserialize(serializedAnno).head
assert(anno == deserAnno)
}

"JsonProtocol" should "support serializing directly to a Java Writer" in {
val anno = SimpleAnnotation("hello")
class NaiveWriter extends java.io.Writer {
private var contents: String = ""
def value: String = contents
def close(): Unit = contents = ""
def flush(): Unit = contents = ""
def write(cbuff: Array[Char], off: Int, len: Int): Unit = {
for (i <- off until off + len) {
contents += cbuff(i)
}
}
}
val w = new NaiveWriter
JsonProtocol.serializeTry(Seq(anno), w)
val ser1 = w.value
val ser2 = JsonProtocol.serialize(Seq(anno))
assert(ser1 == ser2)
}
}
Loading