_site/cache-intro/index.html - public/gem5-website - Git at Google

 <!DOCTYPE html>
 <html>
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="x-ua-compatible" content="ie=edge">
 	<meta name="viewport" content="width=device-width, initial-scale=1">

 	<title>gem5</title>

 	<!-- SITE FAVICON -->
 	<link rel="shortcut icon" type="image/gif" href="/assets/img/gem5ColorVert.gif"/>

 	<link rel="canonical" href="http://localhost:4000/cache-intro/">
 	<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,300,700,800,600' rel='stylesheet' type='text/css'>
 	<link href='https://fonts.googleapis.com/css?family=Muli:400,300' rel='stylesheet' type='text/css'>

 	<!-- FAVICON -->
 	<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">

 	<!-- BOOTSTRAP -->
 	<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">

 	<!-- CUSTOM CSS -->
 	<link rel="stylesheet" href="/css/main.css">
 </head>


 <body>
 	<nav class="navbar navbar-expand-md navbar-light bg-light">
   <a class="navbar-brand" href="/">
 		<img src="/assets/img/gem5ColorLong.gif" alt="gem5" height=45px>
 	</a>
   <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false" aria-label="Toggle navigation">
     <span class="navbar-toggler-icon"></span>
   </button>
   <div class="collapse navbar-collapse" id="navbarNavDropdown">
     <ul class="navbar-nav ml-auto">
       <li class="nav-item ">
         <a class="nav-link" href="/">Home</a>
       </li>

 			<li class="nav-item dropdown ">
 				<a class="nav-link dropdown-toggle" href="/about" id="navbarDropdownMenuLink" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
 					About
 				</a>
 				<div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">
           <a class="dropdown-item" href="/about">About</a>
           <a class="dropdown-item" href="/publications">Publications</a>
           <a class="dropdown-item" href="/governance">Governance</a>
 				</div>
 			</li>

 			<li class="nav-item dropdown active">
 				<a class="nav-link dropdown-toggle" href="#" id="navbarDropdownMenuLink" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
 					Documentation
 				</a>
 				<div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">
 					<!-- Pull navigation from _data/documentation.yml -->

             <a class="dropdown-item" href="/introduction">Introduction</a>

             <a class="dropdown-item" href="/building">Getting Started</a>

             <a class="dropdown-item" href="/environment">Modifying/Extending</a>

             <a class="dropdown-item" href="/MSIintro">Modeling Cache Coherence with Ruby</a>

 				</div>
 			</li>

       <li class="nav-item ">
         <a class="nav-link" href="/contributing">Contributing</a>
       </li>

       <li class="nav-item ">
         <a class="nav-link" href="/blog">Blog</a>
       </li>

 			<li class="nav-item ">
         <a class="nav-link" href="/search">Search</a>
       </li>
     </ul>
   </div>
 </nav>

 	<main>
 		<div class="sidenav-top">
   <a href="/"><img src="/assets/img/gem5ColorLong.gif" height="80"></a>
   <div class="search">
     <form action="/search" method="get">
       <!-- <label for="search-box"><i class="fa fa-search"></i></label> -->
       <input type="text" name="query">
       <button type="submit" name="submit"><i class="fa fa-search"></i></button>
     </form>
   </div>
 </div>
 <div class="sidenav">
   <!-- Pull navigation from _data/documentation.yml -->

     <a class="item" href="/introduction" role="button" aria-expanded="false" aria-controls="collapseExample">
       Introduction
     </a>
     <div class="collapse " id="introduction">

     </div>

     <a class="item" data-toggle="collapse" href="#pt1" role="button" aria-expanded="false" aria-controls="collapseExample">
       Getting Started
     </a>
     <div class="collapse " id="pt1">

         <a class="subitem " href="/building">Building gem5</a>

         <a class="subitem " href="/simple_config">Creating a simple configuration script</a>

         <a class="subitem " href="/cache_config">Adding cache to configuration script</a>

         <a class="subitem " href="/gem5_stats">Understanding gem5 statistics and output</a>

         <a class="subitem " href="/example_configs">Using the default configuration scripts</a>

     </div>

     <a class="item" data-toggle="collapse" href="#pt2" role="button" aria-expanded="false" aria-controls="collapseExample">
       Modifying/Extending
     </a>
     <div class="collapse " id="pt2">

         <a class="subitem " href="/environment">Setting up your development environment</a>

         <a class="subitem " href="/helloobject">Creating a very simple SimObject</a>

         <a class="subitem " href="/debugging">Debugging gem5</a>

         <a class="subitem " href="/events">Event-driven programming</a>

         <a class="subitem " href="/parameters">Adding parameters to SimObjects and more events</a>

         <a class="subitem " href="/memoryobject">Creating SimObjects in the memory system</a>

         <a class="subitem " href="/simplecache">Creating a simple cache object</a>

     </div>

     <a class="item" data-toggle="collapse" href="#pt3" role="button" aria-expanded="false" aria-controls="collapseExample">
       Modeling Cache Coherence with Ruby
     </a>
     <div class="collapse show" id="pt3">

         <a class="subitem " href="/MSIintro">Introduction to Ruby</a>

         <a class="subitem active" href="/cache-intro">MSI example cache protocol</a>

         <a class="subitem " href="/cache-declarations">Declaring a state machine</a>

         <a class="subitem " href="/cache-in-ports">In port code blocks</a>

         <a class="subitem " href="/cache-actions">Action code blocks</a>

         <a class="subitem " href="/cache-transitions">Transition code blocks</a>

         <a class="subitem " href="/directory">MSI Directory implementation</a>

         <a class="subitem " href="/MSIbuilding">Compiling a SLICC protocol</a>

         <a class="subitem " href="/configuration">Configuring a simple Ruby system</a>

         <a class="subitem " href="/running">Running the simple Ruby system</a>

         <a class="subitem " href="/MSIdebugging">Debugging SLICC Protocols</a>

         <a class="subitem " href="/simple-MI_example">Configuring for a standard protocol</a>

     </div>

 </div>

 <div class="container" id="doc-container">
   <div class="edit"><a href="https://github.com/gem5/new-website/tree/master/_pages/documentation/part3/cache-intro.md">Edit this page</a></div>
   <dl>
   <dt>authors</dt>
   <dd>Jason Lowe-Power</dd>
 </dl>

 <h1 id="msi-example-cache-protocol">MSI example cache protocol</h1>

 <p>Before we implement a cache coherence protocol, it is important to have
 a solid understanding of cache coherence. This section leans heavily on
 the great book <em>A Primer on Memory Consistency and Cache Coherence</em> by
 Daniel J. Sorin, Mark D. Hill, and David A. Wood which was published as
 part of the Synthesis Lectures on Computer Architecture in 2011
 (<a href="DOI:`10.2200/S00346ED1V01Y201104CAC016">DOI:`10.2200/S00346ED1V01Y201104CAC016</a>
 &lt;&lt;https://doi.org/10.2200/S00346ED1V01Y201104CAC016&gt;&gt;_).
 If you are unfamiliar with cache coherence, I strongly advise reading that book before continuing.</p>

 <p>In this chapter, we will be implementing an MSI protocol.
 (An MSI protocol has three stable states, modified with read-write permission, shared with read-only permission, and invalid with no permissions.)
 We will implement this as a three-hop directory protocol (i.e., caches can send data directly to other caches without going through the directory).
 Details for the protocol can be found in Section 8.2 of the *Primer on Memory Consistency and Cache Coherence* (pages 141-149).
 It will be helpful to print out Section 8.2 to reference as you are implementing the protocol.</p>

 <p>You can download an exceprt of Sorin et al. that contains Section 8.2 :download:here
 &lt;../../_static/external/Sorin_et-al_Excerpt_8.2.pdf&gt;.</p>

 <p>First steps to writing a protocol
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</p>

 <p>Let’s start by creating a new directory for our protocol: src/learning_gem5/MSI_protocol.
 In this directory, like in all gem5 source directories, we need to create a file for SCons to know what to compile.
 However, this time, instead of creating a SConscript` file, we are
 going to create a <code class="highlighter-rouge">SConsopts</code> file. (The <code class="highlighter-rouge">SConsopts</code> files are processed
 before the <code class="highlighter-rouge">SConscript</code> files and we need to run the SLICC compiler
 before SCons executes.)</p>

 <p>We need to create a <code class="highlighter-rouge">SConsopts</code> file with the following:</p>

 <p>``` {.sourceCode .python}
 Import(‘*’)</p>

 <p>all_protocols.extend([
 ‘MSI’,
 ])</p>

 <p>protocol_dirs.append(str(Dir(‘.’).abspath))
 ```</p>

 <p>We do two things in this file. First, we register the name of our
 protocol (<code class="highlighter-rouge">'MSI'</code>). Since we have named our protocol MSI, SCons will
 assume that there is a file named <code class="highlighter-rouge">MSI.slicc</code> which specifies all of the
 state machine files and auxiliary files. We will create that file after
 writing all of our state machine files. Second, the <code class="highlighter-rouge">SConsopts</code> files
 tells the SCons to look in the current directory for files to pass to
 the SLICC compiler.</p>

 <p>You can download the <code class="highlighter-rouge">SConsopts</code> file
 here &lt;../../_static/scripts/part3/MSI_protocol/SConsopts&gt;.</p>

 <h2 id="writing-a-state-machine-file">Writing a state machine file</h2>

 <p>The next step, and most of the effort in writing a protocol, is to
 create the state machine files. State machine files generally follow the
 outline:</p>

 <dl>
   <dt>Parameters</dt>
   <dd>These are the parameters for the SimObject that will be generated
 from the SLICC code.</dd>
   <dt>Declaring required structures and functions</dt>
   <dd>This section declares the states, events, and many other required
 structures for the state machine.</dd>
   <dt>In port code blocks</dt>
   <dd>Contain code that looks at incoming messages from the (<code class="highlighter-rouge">in_port</code>)
 message buffers and determines what events to trigger.</dd>
   <dt>Actions</dt>
   <dd>These are simple one-effect code blocks (e.g., send a message) that
 are executed when going through a transition.</dd>
   <dt>Transitions</dt>
   <dd>Specify actions to execute given a starting state and an event and
 the final state. This is the meat of the state machine definition.</dd>
 </dl>

   <br>

   <!-- RETRIVE PREVIOUS PAGE LINK -->


   <!-- RETRIEVE NEXT PAGE LINK -->


   <div class="navbuttons">

       <a href="/MSIintro"><button type="button" class="btn btn-outline-primary">PREVIOUS</button></a>


       <a href="/cache-declarations"><button type="button" class="btn btn-outline-primary">NEXT</button></a>

   </div>
 </div>

 	</main>


 	<script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
 	<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script>
 	<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js" integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous"></script>

 	<script>
 	  // When the user scrolls down 20px from the top of the document, show the button
 	  window.onscroll = function() {scrollFunction()};

 	  function scrollFunction() {
 	      if (document.body.scrollTop > 100 || document.documentElement.scrollTop > 20) {
 	          document.getElementById("myBtn").style.display = "block";
 	      } else {
 	          document.getElementById("myBtn").style.display = "none";
 	      }
 	  }

 	  // When the user clicks on the button, scroll to the top of the document
 	  function topFunction() {
 	      document.body.scrollTop = 0;
 	      document.documentElement.scrollTop = 0;
 	  }
 	</script>

 </body>


 </html>
	<!DOCTYPE html>
	<html>
	<head>
	<meta charset="utf-8">
	<meta http-equiv="x-ua-compatible" content="ie=edge">
	<meta name="viewport" content="width=device-width, initial-scale=1">

	<title>gem5</title>

	<!-- SITE FAVICON -->
	<link rel="shortcut icon" type="image/gif" href="/assets/img/gem5ColorVert.gif"/>

	<link rel="canonical" href="http://localhost:4000/cache-intro/">
	<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,300,700,800,600' rel='stylesheet' type='text/css'>
	<link href='https://fonts.googleapis.com/css?family=Muli:400,300' rel='stylesheet' type='text/css'>

	<!-- FAVICON -->
	<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">

	<!-- BOOTSTRAP -->
	<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">

	<!-- CUSTOM CSS -->
	<link rel="stylesheet" href="/css/main.css">
	</head>


	<body>
	<nav class="navbar navbar-expand-md navbar-light bg-light">
	<a class="navbar-brand" href="/">
	<img src="/assets/img/gem5ColorLong.gif" alt="gem5" height=45px>
	</a>
	<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false" aria-label="Toggle navigation">
	<span class="navbar-toggler-icon"></span>
	</button>
	<div class="collapse navbar-collapse" id="navbarNavDropdown">
	<ul class="navbar-nav ml-auto">
	<li class="nav-item ">
	<a class="nav-link" href="/">Home</a>
	</li>

	<li class="nav-item dropdown ">
	<a class="nav-link dropdown-toggle" href="/about" id="navbarDropdownMenuLink" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
	About
	</a>
	<div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">
	<a class="dropdown-item" href="/about">About</a>
	<a class="dropdown-item" href="/publications">Publications</a>
	<a class="dropdown-item" href="/governance">Governance</a>
	</div>
	</li>

	<li class="nav-item dropdown active">
	<a class="nav-link dropdown-toggle" href="#" id="navbarDropdownMenuLink" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
	Documentation
	</a>
	<div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">
	<!-- Pull navigation from _data/documentation.yml -->

	<a class="dropdown-item" href="/introduction">Introduction</a>

	<a class="dropdown-item" href="/building">Getting Started</a>

	<a class="dropdown-item" href="/environment">Modifying/Extending</a>

	<a class="dropdown-item" href="/MSIintro">Modeling Cache Coherence with Ruby</a>

	</div>
	</li>

	<li class="nav-item ">
	<a class="nav-link" href="/contributing">Contributing</a>
	</li>

	<li class="nav-item ">
	<a class="nav-link" href="/blog">Blog</a>
	</li>

	<li class="nav-item ">
	<a class="nav-link" href="/search">Search</a>
	</li>
	</ul>
	</div>
	</nav>

	<main>
	<div class="sidenav-top">
	<a href="/"><img src="/assets/img/gem5ColorLong.gif" height="80"></a>
	<div class="search">
	<form action="/search" method="get">
	<!-- <label for="search-box"><i class="fa fa-search"></i></label> -->
	<input type="text" name="query">
	<button type="submit" name="submit"><i class="fa fa-search"></i></button>
	</form>
	</div>
	</div>
	<div class="sidenav">
	<!-- Pull navigation from _data/documentation.yml -->

	<a class="item" href="/introduction" role="button" aria-expanded="false" aria-controls="collapseExample">
	Introduction
	</a>
	<div class="collapse " id="introduction">

	</div>

	<a class="item" data-toggle="collapse" href="#pt1" role="button" aria-expanded="false" aria-controls="collapseExample">
	Getting Started
	</a>
	<div class="collapse " id="pt1">

	<a class="subitem " href="/building">Building gem5</a>

	<a class="subitem " href="/simple_config">Creating a simple configuration script</a>

	<a class="subitem " href="/cache_config">Adding cache to configuration script</a>

	<a class="subitem " href="/gem5_stats">Understanding gem5 statistics and output</a>

	<a class="subitem " href="/example_configs">Using the default configuration scripts</a>

	</div>

	<a class="item" data-toggle="collapse" href="#pt2" role="button" aria-expanded="false" aria-controls="collapseExample">
	Modifying/Extending
	</a>
	<div class="collapse " id="pt2">

	<a class="subitem " href="/environment">Setting up your development environment</a>

	<a class="subitem " href="/helloobject">Creating a very simple SimObject</a>

	<a class="subitem " href="/debugging">Debugging gem5</a>

	<a class="subitem " href="/events">Event-driven programming</a>

	<a class="subitem " href="/parameters">Adding parameters to SimObjects and more events</a>

	<a class="subitem " href="/memoryobject">Creating SimObjects in the memory system</a>

	<a class="subitem " href="/simplecache">Creating a simple cache object</a>

	</div>

	<a class="item" data-toggle="collapse" href="#pt3" role="button" aria-expanded="false" aria-controls="collapseExample">
	Modeling Cache Coherence with Ruby
	</a>
	<div class="collapse show" id="pt3">

	<a class="subitem " href="/MSIintro">Introduction to Ruby</a>

	<a class="subitem active" href="/cache-intro">MSI example cache protocol</a>

	<a class="subitem " href="/cache-declarations">Declaring a state machine</a>

	<a class="subitem " href="/cache-in-ports">In port code blocks</a>

	<a class="subitem " href="/cache-actions">Action code blocks</a>

	<a class="subitem " href="/cache-transitions">Transition code blocks</a>

	<a class="subitem " href="/directory">MSI Directory implementation</a>

	<a class="subitem " href="/MSIbuilding">Compiling a SLICC protocol</a>

	<a class="subitem " href="/configuration">Configuring a simple Ruby system</a>

	<a class="subitem " href="/running">Running the simple Ruby system</a>

	<a class="subitem " href="/MSIdebugging">Debugging SLICC Protocols</a>

	<a class="subitem " href="/simple-MI_example">Configuring for a standard protocol</a>

	</div>

	</div>

	<div class="container" id="doc-container">
	<div class="edit"><a href="https://github.com/gem5/new-website/tree/master/_pages/documentation/part3/cache-intro.md">Edit this page</a></div>
	<dl>
	<dt>authors</dt>
	<dd>Jason Lowe-Power</dd>
	</dl>

	<h1 id="msi-example-cache-protocol">MSI example cache protocol</h1>

	<p>Before we implement a cache coherence protocol, it is important to have
	a solid understanding of cache coherence. This section leans heavily on
	the great book <em>A Primer on Memory Consistency and Cache Coherence</em> by
	Daniel J. Sorin, Mark D. Hill, and David A. Wood which was published as
	part of the Synthesis Lectures on Computer Architecture in 2011
	(<a href="DOI:`10.2200/S00346ED1V01Y201104CAC016">DOI:`10.2200/S00346ED1V01Y201104CAC016</a>
	<<https://doi.org/10.2200/S00346ED1V01Y201104CAC016>>_).
	If you are unfamiliar with cache coherence, I strongly advise reading that book before continuing.</p>

	<p>In this chapter, we will be implementing an MSI protocol.
	(An MSI protocol has three stable states, modified with read-write permission, shared with read-only permission, and invalid with no permissions.)
	We will implement this as a three-hop directory protocol (i.e., caches can send data directly to other caches without going through the directory).
	Details for the protocol can be found in Section 8.2 of the Primer on Memory Consistency and Cache Coherence (pages 141-149).
	It will be helpful to print out Section 8.2 to reference as you are implementing the protocol.</p>

	<p>You can download an exceprt of Sorin et al. that contains Section 8.2 :download:here
	<../../_static/external/Sorin_et-al_Excerpt_8.2.pdf>.</p>

	<p>First steps to writing a protocol
	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</p>

	<p>Let’s start by creating a new directory for our protocol: src/learning_gem5/MSI_protocol.
	In this directory, like in all gem5 source directories, we need to create a file for SCons to know what to compile.
	However, this time, instead of creating a SConscript` file, we are
	going to create a <code class="highlighter-rouge">SConsopts</code> file. (The <code class="highlighter-rouge">SConsopts</code> files are processed
	before the <code class="highlighter-rouge">SConscript</code> files and we need to run the SLICC compiler
	before SCons executes.)</p>

	<p>We need to create a <code class="highlighter-rouge">SConsopts</code> file with the following:</p>

	<p>``` {.sourceCode .python}
	Import(‘*’)</p>

	<p>all_protocols.extend([
	‘MSI’,
	])</p>

	<p>protocol_dirs.append(str(Dir(‘.’).abspath))
	```</p>

	<p>We do two things in this file. First, we register the name of our
	protocol (<code class="highlighter-rouge">'MSI'</code>). Since we have named our protocol MSI, SCons will
	assume that there is a file named <code class="highlighter-rouge">MSI.slicc</code> which specifies all of the
	state machine files and auxiliary files. We will create that file after
	writing all of our state machine files. Second, the <code class="highlighter-rouge">SConsopts</code> files
	tells the SCons to look in the current directory for files to pass to
	the SLICC compiler.</p>

	<p>You can download the <code class="highlighter-rouge">SConsopts</code> file
	here <../../_static/scripts/part3/MSI_protocol/SConsopts>.</p>

	<h2 id="writing-a-state-machine-file">Writing a state machine file</h2>

	<p>The next step, and most of the effort in writing a protocol, is to
	create the state machine files. State machine files generally follow the
	outline:</p>

	<dl>
	<dt>Parameters</dt>
	<dd>These are the parameters for the SimObject that will be generated
	from the SLICC code.</dd>
	<dt>Declaring required structures and functions</dt>
	<dd>This section declares the states, events, and many other required
	structures for the state machine.</dd>
	<dt>In port code blocks</dt>
	<dd>Contain code that looks at incoming messages from the (<code class="highlighter-rouge">in_port</code>)
	message buffers and determines what events to trigger.</dd>
	<dt>Actions</dt>
	<dd>These are simple one-effect code blocks (e.g., send a message) that
	are executed when going through a transition.</dd>
	<dt>Transitions</dt>
	<dd>Specify actions to execute given a starting state and an event and
	the final state. This is the meat of the state machine definition.</dd>
	</dl>

	<br>

	<!-- RETRIVE PREVIOUS PAGE LINK -->





















	<!-- RETRIEVE NEXT PAGE LINK -->


























































	<div class="navbuttons">

	<a href="/MSIintro"><button type="button" class="btn btn-outline-primary">PREVIOUS</button></a>



	<a href="/cache-declarations"><button type="button" class="btn btn-outline-primary">NEXT</button></a>

	</div>
	</div>

	</main>


	<script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
	<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script>
	<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js" integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous"></script>

	<script>
	// When the user scrolls down 20px from the top of the document, show the button
	window.onscroll = function() {scrollFunction()};

	function scrollFunction() {
	if (document.body.scrollTop > 100 \|\| document.documentElement.scrollTop > 20) {
	document.getElementById("myBtn").style.display = "block";
	} else {
	document.getElementById("myBtn").style.display = "none";
	}
	}

	// When the user clicks on the button, scroll to the top of the document
	function topFunction() {
	document.body.scrollTop = 0;
	document.documentElement.scrollTop = 0;
	}
	</script>

	</body>


	</html>